/************************************
*  Copyright (C) 2010 Julien MOTTIN.
*  Contact: julien.mottin@gueydan.eu
*
*  This file is part of Gueydan.
*
*  Gueydan is free software: you can redistribute it and/or modify
*  it under the terms of the GNU General Public License as published by
*  the Free Software Foundation, either version 3 of the License, or
*  (at your option) any later version.
*
*  Gueydan is distributed in the hope that it will be useful,
*  but WITHOUT ANY WARRANTY; without even the implied warranty of
*  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
*  GNU General Public License for more details.
*
*  You should have received a copy of the GNU General Public License
*  along with Gueydan.  If not, see <http://www.gnu.org/licenses/>.
*
*************************************/
#ifndef MISC_H
#define MISC_H

// Local
#include "duration.h"
#include "volume.h"
#include "weight.h"
#include "beerxmlobject.h"

// QtCore
#include <QString>

enum MiscType
{
    MTSpice = 0,
    MTFining,
    MTWaterAgent,
    MTHerb,
    MTFlavor,
    MTOther
};

enum MiscUse
{
    MUMash = 0,
    MUBoil,
    MUPrimary,
    MUSecondary,
    MUBottling
};

class QDomNode;

class Misc : public BeerXMLObject
{
    Q_OBJECT;
    
public:

    // Standard Constructors with all mandatory fields
    Misc(const QString &iName,
         const int iVersion,
         const MiscType iType,
         const MiscUse iUse,
         const Duration &iTime,
         const Volume &iAmount);

    Misc(const QString &iName,
         const int iVersion,
         const MiscType iType,
         const MiscUse iUse,
         const Duration &iTime,
         const Weight &iAmount);

    // empty Ctor
    Misc();

    // Dtor
    ~Misc();

    // Conveniance Operators
    bool operator==(const Misc &iOther) const;
    bool operator!=(const Misc &iOther) const;

    /*
    * XML IO
    * returns :
    *   - 0 : Success
    *   - 1 : Invalid XML
    */
    int CreateFromXMLNode(const QDomNode &iNode);
    int ToXMLNode(QDomNode &iParentNode) const;

public:

    // Internal data
    MiscType    _Type;
    MiscUse     _Use;
    Duration    _Time;
    Volume      _AmountV;
    Weight      _AmountW;
    bool        _AmountIsWeight;
    QString     _UseFor;
    QString     _Notes;

private:
    Misc(const Misc &);
    Misc & operator=(const Misc &);
};

#endif // MISC_H
